Krill SDK/krill.zone.shared.events

Package-level declarations

Types

@Serializable

data class EmptyPayload(val noop: String = "") : EventPayload

Empty EventPayload used as the default when no extra data is needed.

@Serializable

data class Event(val id: String, val type: EventType, val payload: EventPayload = EmptyPayload(), val timestamp: Long = Clock.System.now().toEpochMilliseconds(), val eventId: String = Uuid.random().toString())

The wire envelope every SSE / event-bus message rides in.

EventPayload

interface EventPayload

Marker interface implemented by every payload that travels inside an Event. Polymorphic — concrete subclasses are registered in the project-wide serializer module under EventPayload's class.

EventType

enum EventType : Enum<EventType>

The kind of swarm event being broadcast.

NodeCreatedPayload

@Serializable

data class NodeCreatedPayload(val node: Node) : EventPayload

Payload of a CREATED event — the brand-new node, in full.

PinEventPayload

@Serializable

data class PinEventPayload(val state: DigitalState) : EventPayload

New pin level after a PIN_CHANGED event.

SnapshotUpdatedEventPayload

@Serializable

data class SnapshotUpdatedEventPayload(val snapshot: Snapshot) : EventPayload

New snapshot captured by a DataPoint.

SourceTriggerPayload

@Serializable

data class SourceTriggerPayload(val triggeringSource: NodeIdentity, val nodeAction: NodeAction = NodeAction.EXECUTE, val epoch: Long = 0, val hopTtl: Int = DEFAULT_HOP_TTL) : EventPayload

Identifies the node that just changed and the verb it owns, delivered to every node that lists it as a source with a firing invocationTrigger.

StateChangeEventPayload

@Serializable

data class StateChangeEventPayload(val state: NodeState) : EventPayload

New lifecycle state after a STATE_CHANGE event.